Identity-User

[GET] /api/v2/identity/users

获取所有用户的信息。

参数:

名称	类型	位置	描述	示例
Provider	string	query	用户提供程序名称。	`"local"`
PageSize	int32	query	页面大小。	`20`
PageNumber	int32	query	页码。	`1`
SearchText	string	query	搜索文本。	`"admin"`
OrderBy	string	query	排序字段。	`"UserName"`
OrderType	OrderType	query	排序类型，可用值为“asc”和“desc”。	`"ASC"`
Paging	Boolean	query	是否分页。	`true`
SearchType	SearchType	query	搜索类型，可用值为“none”和“count”。	`"None"`

返回值

状态码: 200

成功

GrapeCity.Enterprise.Identity.Models.ModelSearchResponse`1[[GrapeCity.Enterprise.Identity.Database.Models.UserBizModel, GrapeCity.Enterprise.IdentityService, Version=9.0.112.0, Culture=neutral, PublicKeyToken=null]]

[POST] /api/v2/identity/users

创建一个新用户。

请求数据格式

UserCreationModel

返回值

状态码: 201

已创建

UserBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

[GET] /api/v2/identity/users/{id}

通过id获取用户信息。

参数:

名称	类型	位置	描述
id必填项	string	path	用户 ID。

返回值

状态码: 200

成功

UserBizModel

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/users/{id}

更新用户信息。

参数:

名称	类型	位置	描述
id必填项	string	path	用户 id。
ignoreRoles	Boolean	query	是否忽略用户角色。

请求数据格式

UserUpdateModel

返回值

状态码: 200

成功

UserBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/users/{id}

移除现有用户。

参数:

名称	类型	位置	描述
id必填项	string	path	用户 id。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/users/batch-delete

删除指定用户。

请求数据格式

BatchDeleteUsersModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

[GET] /api/v2/identity/users/{id}/roles

获取用户的角色。

参数:

名称	类型	位置	描述
id必填项	string	path	用户 id。

返回值

状态码: 200

成功

Array<string>

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/users/{id}/enable

启用/禁用用户。

参数:

名称	类型	位置	描述
id必填项	string	path	用户 id。

请求数据格式

boolean

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/users/{id}/password

更改指定用户的密码。

参数:

名称	类型	位置	描述
id必填项	string	path	用户 id。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/users/me/change-password

更改用户密码。

请求数据格式

ChangePasswordModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/users/import

导入用户。

返回值

状态码: 200

成功

ImportUserResult

[GET] /api/v2/identity/users/export

导出所有用户信息。

返回值

状态码: 200

成功

binary

[GET] /api/v2/identity/users/template

导出用户信息模板。

返回值

状态码: 200

成功

binary

[GET] /api/v2/identity/users/template/{key}

获取用户导入结果文件，查看详细的错误信息。

参数:

名称	类型	位置	描述
key必填项	string	path	用户模板文件的key。

返回值

状态码: 200

成功

binary

状态码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/users/template/{key}

删除无用的用户模板文件。

参数:

名称	类型	位置	描述
key必填项	string	path	用户模板文件的key。

返回值

状态码: 204

无内容

状态码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/users/locked

获取锁定的用户。

返回值

状态码: 200

成功

LockedUserModel

[POST] /api/v2/identity/users/{id}/unlock

通过 id 解锁用户。

参数:

名称	类型	位置	描述
id必填项	string	path	用户 id。

返回值

状态码: 204

无内容

[GET] /api/v2/identity/users/available-context

获取可用的用户上下文。

返回值

状态码: 200

成功

UserContextItem

[GET] /api/v2/identity/users/me

获取当前用户的声明。

返回值

状态码: 200

成功

SimpleClaimModel

[GET] /api/v2/identity/users/{id}/avatar

获取指定用户的头像。

参数:

名称	类型	位置	描述
id必填项	string	path	用户 ID。
ignoreDefault	Boolean	query	如果用户没有自定义头像，则 true 会阻止返回默认头像（不返回任何内容）；否则没有效果。

返回值

状态码: 200

成功

binary

状态码: 304

未修改

状态码: 400

错误的请求

ApiErrorResult

状态码: 401

未经授权

ApiErrorResult

[PUT] /api/v2/identity/users/me/avatar

添加或更新当前用户的头像。

请求数据格式

binary

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

[GET] /api/v2/identity/users/me/profile

获取当前用户的个人资料信息。

返回值

状态码: 200

成功

UserProfileRequestModel

状态码: 400

错误的请求

ApiErrorResult

[PUT] /api/v2/identity/users/me/profile

更新当前用户的个人资料信息。

请求数据格式

UserProfileRequestModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

[GET] /api/v2/identity/users/me/sharing-roles

获取当前登录用户可以共享文档的角色。

返回值

状态码: 200

成功

SharingRoleModel

[GET] /api/v2/identity/users/{id}/permissions

获取指定用户的权限。

参数:

名称	类型	位置	描述
id必填项	string	path	用户 id。

返回值

状态码: 200

成功

Array<string>

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/users/me/organizations

获取当前用户所属的所有组织。

返回值

状态码: 200

成功

UserTenantBizModel

[POST] /api/v2/identity/users/me/default-organization

设置用户可以直接登录的默认组织。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/users/me/default-organization

删除当前用户的默认组织设置。

返回值

状态码: 204

无内容

类型定义

Ƭ OrderType

Enum:

ASC
DESC

顺序类型。

* asc - 0 - 升序。
* desc - 1 - 降序。

Ƭ SearchType

Enum:

None
Count

用于搜索记录的搜索类型。

* none - 0 - 正常搜索。
* count - 1 - 仅检索记录计数。

Ƭ GrapeCity.Enterprise.Identity.Models.ModelSearchResponse`1[[GrapeCity.Enterprise.Identity.Database.Models.UserBizModel, GrapeCity.Enterprise.IdentityService, Version=9.0.112.0, Culture=neutral, PublicKeyToken=null]]

名称	类型	描述	示例
models可为空	UserBizModel
total	int32
pageSize可为空	int32	页面大小。	`20`
pageNumber可为空	int32	页码。	`1`
searchText可为空	string	搜索文本。	`"admin"`
orderBy可为空	string	排序字段。	`"UserName"`
orderType	OrderType
paging可为空	Boolean	是否分页。	`true`
searchType	SearchType

Ƭ UserBizModel

名称	类型	描述	示例
id可为空	string
username可为空	string
email可为空	string
mobile可为空	string
provider可为空	string
avatar可为空	string
firstName可为空	string
lastName可为空	string
creationTime	ISO DateTime Sting
status	UserStatus
fullName可为空	string
organizationIdPath可为空	string
lastLoginTime可为空	ISO DateTime Sting
passwordChangeTime可为空	ISO DateTime Sting
passwordExpirationPolicy	UserPasswordExpirationPolicy
roles可为空	`Array<string>`
customizeProperties可为空	`Array<string>`
extraClaims可为空	string
tenantRoles可为空	`Array<string>`

Ƭ UserStatus

Enum:

Normal
Disabled

用户的状态。

* normal - 1 - 正常状态。
* disabled - 2 - 禁用状态。

Ƭ UserPasswordExpirationPolicy

Enum:

FollowSystem
NeverExpire

Ƭ ApiErrorResult

该模型用于描述处理 Web 请求时发生的所有错误。

名称	类型	描述	示例
errors可为空	ApiError	错误列表。

Ƭ ApiError

该模型用于描述处理 Web 请求时发生的错误。

名称	类型	描述
code可为空	string	错误的唯一标识。
message可为空	string	错误的描述文本。
context可为空	string	错误的一些相关上下文信息。

Ƭ UserCreationModel

名称	类型	描述	示例
id可为空	string	用户 ID，可以为空。	`"8760F2A1-C217-480F-8EB0-1EE9DB3AE2C5"`
username	string	用户名是必填项，不能修改。	`"MyUserName"`
firstName可为空	string	用户的名字。	`"MyFirstName"`
lastName可为空	string	用户的姓氏。	`"MyLastName"`
fullName可为空	string	用户的全名。	`"MyFullName"`
email	string	用户的电子邮件地址，必填。	`"example@gmail.com"`
mobile可为空	string	手机号码。	`"88888888888"`
password可为空	string	用户的密码。	`"MyPassword"`
passwordExpirationPolicy	UserPasswordExpirationPolicy
provider可为空	string	用户提供程序，默认值为本地。	`"local"`
enabled	Boolean	用户是启用还是禁用。	`true`
organizationId可为空	string	用户所在的组织 ID。	`"D6F4019D-54FB-4B30-AA84-424010ABA3C5"`
managerId可为空	string	可以管理用户的组织id。	`"14A7B860-32A4-4F2B-BFC2-C511F45022C2"`
roles可为空	`Array<string>`	用户所属的角色。	`["ReportDesigner","DataManager"]`
customProperties可为空	`Array<string>`	自定义属性。	`{"Gender":["male"],"ExternalRoles":["DBA","Support"]}`

Ƭ UserUpdateModel

名称	类型	描述	示例
firstName可为空	string	用户的名字。	`"MyFirstName"`
lastName可为空	string	用户的姓氏。	`"MyLastName"`
fullName可为空	string	用户的全名。	`"MyFullName"`
email	string	用户的电子邮件地址，必填。	`"example@gmail.com"`
mobile可为空	string	用户的手机号码。	`"88888888888"`
password可为空	string	用户密码，为空表示不修改原密码。	`"MyNewPassword"`
passwordExpirationPolicy	UserPasswordExpirationPolicy
enabled	Boolean	是否启用或禁用用户。	`true`
organizationId可为空	string	用户所在的组织 ID。	`"DD6DAFF7-6789-46E3-9294-C4D74542D971"`
managerId可为空	string	可以管理用户的组织id。	`"4DBED725-F4AB-4EC6-AD28-C164613FE294"`
roles可为空	`Array<string>`	用户所属的角色。	`["ReportDesigner","DataManager"]`
customProperties可为空	`Array<string>`	自定义属性。	`{"Gender":["male"],"ExternalRoles":["DBA","Support"]}`

Ƭ BatchDeleteUsersModel

名称	类型	描述	示例
userIds	`Array<string>`	用户 ID 列表。	`["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"]`

Ƭ ChangePasswordModel

名称	类型	描述	示例
oldPassword	string	旧密码。	`"OldPassword"`
newPassword	string	新密码。	`"NewPassword"`
newPasswordConfirm	string	确认密码。	`"NewPassword"`

Ƭ ImportUserResult

名称	类型	描述
importedUserCount	int32	成功导入的用户数。
notImportedUserCount	int32	导入失败的用户计数。
detailKey可为空	string	用于检索有关导入错误的详细信息的唯一键值。
errorMsg可为空	string	错误消息。

Ƭ LockedUserModel

名称	类型	描述	示例
id可为空	string
username可为空	string
provider可为空	string

Ƭ UserContextItem

名称	类型	描述
name可为空	string	用户上下文名称。
isBuiltIn	Boolean	是否为内置的用户上下文信息。
multivalued	Boolean	是否为多值的用户上下文信息。
valueType	PropertyValueType
sensitive	Boolean	这是否是敏感的用户上下文。

Ƭ PropertyValueType

Enum:

Text
Boolean
Integer
Float
Date
DateTime

组织属性的值类型。

* text - 0 - 普通字符串。
* boolean - 1 - 布尔值。
* integer - 2 - 整数。
* float - 3 - 浮点数。
* date - 4 - 日期
* datetime - 5 - 日期时间

Ƭ SimpleClaimModel

名称	类型	描述
type可为空	string	声明类型。
value可为空	string	声明值。
displayValue可为空	string	声明显示值。
valueType	PropertyValueType
literalValueType可为空	string	声明值文字类型。

Ƭ UserProfileRequestModel

名称	类型	描述	示例
firstName可为空	string	名字。	`"MyFirstName"`
lastName可为空	string	姓氏。	`"MyLastName"`
fullName可为空	string	全名。	`"MyFullName"`
mobile可为空	string	手机号码。	`"88888888888"`
customProperties可为空	`Array<string>`	自定义属性。	`{"Gender":["male"],"ExternalRoles":["DBA","Support"]}`

Ƭ SharingRoleModel

名称	类型	描述
id可为空	string	角色 ID。
name可为空	string	角色名称。
tenantId可为空	string	租户 ID。
isBuiltIn	Boolean	是否是内置角色。
permissions可为空	`Array<string>`	角色的权限。

Ƭ UserTenantBizModel

名称	类型	描述
id可为空	string	组织 ID。
name可为空	string	组织名称。
path可为空	string	组织路径。
isDefault	Boolean	该组织是否为用户的默认组织。